diff --git a/README.md b/README.md index acfecc0a..b0624283 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 bd0516fb..5104e134 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJy1XFuP27YS/i9GH9VWvIgi922zSdoA2SZY94KiCBaqxPXqVJYcSc7JniL//WAo2SFly+bQmxd74dXM93FIDoczpP5dtE3Td4urvxSVJCIRIZxHhAgWERrDn1QyAp8pfFISR4okKlKEi4hwzknEGCfmzxQeUDKSSaIiwilVEWfKPAYqOE1YJBMZR5JQwEiliAhJlAT11GgX8Cl5JBMKvxKgRBKiIiZUJPmgjMpIxgn8X6QqIsNDXCbwv9hQIYBPUmm0iYgkMZBL4oRGkqgkUjG0jysBBIQC4oykH6JFqx8qnfdlU3eLq38XBD7qbK0XV4vrTXm92SyixT9lXSyuCJXRYttWi6tFXmVdp7sfhyd+eOzX1SIafl1cLfqu+B5Evh9+iBb5Y1kVra4XV38x+eFLtGDShXmbrf8usvNg++fOQAKEUBbGm+tt//i6rHrd7iFoInYQZd3r9iHLdfej9eQsyP7xadvSoXGphfwi68r8CPqRBk4ePd9GHseOHTc3Tf1Qrk4bcXzovHaYF243vWiKp1PK741h6qy6/2F8GjM0CEloRBKlPhjwhLrg77M2W/ujm8d9GimYi/Nuo9sM5oM/1l4E1VyhkqGl0p507zbDXDw9Si38UQA7WHkcG3SapgfoWfWT7gOJ2LIenAwFaXd1CDQK0u0FmqbG1w/GcKbuT7q/rqoQMl/FPE2QKHU41d7UDw1uuoGEx5gXKpkZ8zhIR8wDVzJnrhXF4Vw7a11bytO40llu7vS6+aQDkCeCvuCcOOCbKsvD0F1Jb3hhwd+Gtfw2pN2JvTbdNJunAGBHzBvYXrV+1V0fAOyIeQOrqRtD49pSvrDCnswvyrp4U//xqOt39etqq+t++VT32Wd/CnMaPOkoEU/oXEomiIrr5KUwSy1NiO3fv7upSl3379umb/Km8md17wr6WYYmie39QrGDoIXjeO90VmR/V9rT0e8exwQ3CYeNFGOKmIiYxfYYXbKf+34Dge4yf9Rr/b5tPpXF2cjcojSnwc8cjMXO/uO/3U2rC133ZVa9Md/9E2JBOiaOHaEySehgKWe5eJF1If7aEcNPFsYiWDMjWLvgQ0TgzeGDw4caibIDt3OJw3mO+c2Y44JB8SWO50Kno0Q8kEqPecTL/OGzEBOp3YXLPKuy9tdshZiGOxHPeZfGyokJqjHzgAJ1xDyBZWL7H9d3vKk3236ycT5LYlaFLyHlbK1Xuu59w254FuOKeSyNa4HvSzC/Jx4JCcrTKQZ6/2RLnQB1DMoZVZMevtMft7rrcX06CqGnFBExN0ZmSjhDHMbEtoXlc6nbQt80da8/I0jNacAyhNAnghAk4jyOI86pSQSClyeCQ05RCPMpjW/gbmrpu5um0DkmQILnPbuOU9dkKCQUkBMp/3b31h/mt7u3viDScap9q72zVsPDmLkNgV3EFY0jCLhMxwmWzOPzHfq6KbYVCh0UdptdK2UsDlDQE31EdKTRaSzJ4ohLMTResvhInBtKbCLvRW1blx+3+pdsrd9nra5NnQH65IMbHrNUDISFvQ780Zb9JYQn8lhb7lkpGh9hhRvFOyn8roFKZXwQ0LFovNxuKv051DSONNYwglJjGOB3wAhnlkEGYxTBYhGphJqwG5jY2Y02q7uHpg2ee1MFfk4OKB1jgTPFXgxjjTQetpTwbVF4n3Xdr49ts1094khYgufDm1Q6I/J1WZfdoy5CjT+Rf0b/QhIWm4x2qpzlYOfRJsuCR/LRlkPHHrBKQfHT1P6gkGlX5nrdOt7lLJmdBD5IS5mZxlCMtRi8+qTr/tW67M8XBy0WthSWCfRKJGkiI0UEGSgpd9nO+jK3IQLG2IwKdGqCErO5hu+TFE2/9M1zUJ2o8vNKYNAjyxZ2rLty6HgEgrGvY93dDizZq8+9rruyqfdxPS6zM6fB00JuBPy6rLOq/J/+OauLSrfX7Wq7Ni7Fm86cBm86ap7Ou22/2SJ2SkfFfYk43YTPAYam/SATacZJ4sbT0/Qm1LJ1r1vMpJrV4WmThMrFXM4En7ENztdO7TX4osQpa4279mW5qst6FTCOZxT4Wso5qgBTdNPqrsMPowNRbwJO2rPZ1sVSt5/KXKPziwey+C7iLIJEbASJz6GzpL2deNnkxrqecdrucUyQKIUchomQ/BTyqe3wWVxnQwyITjjadrrwN/sebBAMjgShwabhklxCx5uFgUrExVC+aT4ppbwcjHqCKWfcBoIxPzA4n2dvqbIVFHEQBetBAD1bRcoiyMt/MBycs0BDdt93O2UeRk1SmZhoHM5VutW4ZfHPslz9zmG9CMrOz+vAH+lLkoGk42JtgGdh+Ww0BTm3szndj17bmqPnOhWPIPkZKUaMD1LUmT5HuZxywF5MHCcM53ntTvq7aXvc1tLB3MsHu2MwwYdJujIWEaQRRguxGQvd6Qfd6jqHaKR7qvM73TXbNg9tio9qTz/FnBqerdjRht4EzvI9ptaXK5nb5x83KmJqzCo7n0WCXJ7tZpv8H+0bDQ0Pexy1i3lqz4Xh1Mi0JHYay5HxOUlLlR0Hv2+bz0+v6k+IFXOU8DxpRJgTd49E0QPPlfPF5tQ5zNPU9VCTRsMfiKIzDpQPh1fhQoBtf63bG9325UOZZz3Cc0wE0Wk2TodNrbnGMNlC3uquy1YIMpZQUFE2gsow3MQQdOQknGijKMxMflt2va4D0mwzCnyHUaLk1EMFUwnkMT2DL8RgKBHzSefh3IdPOd0+hk/TA7hu09Sdr3u2RfzO/dum/275mG2gwl6aJBIis3E/kfTtesHVAf5L3QUzsGW9OTgJuGAThFrACRAvMEB4+5U96OwTAafH2qnjAMeO4HAxXvVImXABlzpr80eTnOv8wW0pn7GeSjETCF0UpwU6GYghR3NI92R+VkD2Pag8ZQmi697j2QlCY+IsDhDX7apNu5IEYmk4Ju57JSZ2717tVQUy8EOe3IyJiRjNkvJJN30tkLz4890L+AUzX+c0eBtHzfN5qR+ybdVfRslR4svKvccFy9FYiri06HNWFbqkx9TYs27ZcWz2pXxPqgnnSknspmDu9Kps6kvZnlF0CV8xGQ+Q5XmOwTCv5wK2zhHZ/WIeXhucVYHmuFs9KXWScG/qsi8vqRjOKAjgp0Z+jge4f44y3gkl+DsG8a6v5TS0v4zkczE0FtxRdAqiwZW9gJLexGh8ZzTnwNHtturLTaUh7VN90sXvWbXVt7rPiqzP3tT/0Tk+E+Gv03dJos72EgoEz8nXT1/AIFDw4gUWM/OSgnFAsJgdMf/uzvG36AZ/3b7dwcjhTe/n5f4tONtbpD+vb9++atvGt5ywfx51M56y3aRjTm0ItP2RtTChEfijhMc+iTIhJ3C32cl3UkygbjPUyzCgnDm0kzsRNqha6o8I4KX+iAJWcrz9nziXk66rMvPdhppnca0l4zouUnsd/6UptFPsPI27exwDDZXNyDQ2IjTlbHzzAXdzuLt7Rb758b0AcnALeEsLT8c9p2RkutNDFiYw9QfXLFSy3XsPZkngU6JhBZvjKQI4DG77zG2/asp6Nc0jnzbQRArVXVBIMUzgMqsTfebNGs1kIuXhk3jspIx2TTF7QrM9xawOh8KeywAn1KkttE2uuw5b3Rll8ElpqobsPbzhyNml5Nt2dyMKf+z0iDSeGoOX1kA5aCBInavFL3WflZUugmsxMwp8e41S98Llem32i+G1qqMK8Eb7ai4nzRVkohCzODfxX5Y5YtMIT+NLYjGD93gRCm/sonDJhSdMjSYQdLIZOyh8eF5dPFP7mC+T0aGACO8Sm82r/QRVpTK/LK/mKAlISKZwPShWfKTrlBfvdN8+Lfs26/XqKTC5Mq8DT5aMr3eCt7edyloEbGrndQRstpIdTScOsaopgdmVOQ0hFMepwg9ejvAttuE4vRdsb3eNmrwu7ptsanF68Y1yd+vg3Y7ESkFByxFhXz8vnIzxFPlMOfkMlBWhCedWxXKjLygaHZP2ba4Sk1t5Zd+ZlFyGOEdqSeGXOQUbLK5SWObUmMqDHy1acEABS+qrjLcpUrtLbrMNFnIv4o3o5H6XfbvN+22rsbgTQU90eNvnzBAMG3r4rhdkyCjAK0ePUQmbBSF1S5iPAxUW21a59Lpm3RT6vjN/32/aZl12ugu4w/nly5f/A4dx63Y=" \ No newline at end of file +window.hierarchyData = "eJy1XN1y2zYTfRdNL5mW+OOP7xwnaT0TNxkrbabTyXgYEpb5hSIVkkrjdvLu3yxJKVhalLCgcuMkDnbPwQJYLHYB/reoq6ptFhd/x4IHHvMYk7HHWBB5jPtR7DEehYHHeMzgJ1fKi7kvvZjFzGNSRoEnJBPw15h7jAspvCjwpcckD6UnpeyagQrJ48iLAq68iAWAEQmAC6TwmPBD0B4wUMFjL1KhgF8AJaYC6YmQeZEalAkvYj78f8gl6OkaCR/+TwKQDDp8Dk0EgCgfyCk/Dr2IS9+LmR/BvxkQCGVHPOAfvEWt7wudtnlVNouL/xYMfpTJWi8uFpeb/HKzWXiLT3mZLS4Yj7zFti4WF4u0SJpGN7/0LX5+aNfFwut/u7hYtE32DESe9b/wFulDXmS1LhcXf4vowzdvISIM8zpZf8yS02D7dicgASI0u3J9uW0fXuVFq+s9BFfBDiIvW13fJ6lufjFaToLsm4/7Fvediw3k50mTpwfQD3Rw1PR0H6XPkR03V1V5n6+OG3FodFo7rAs8TM+r7PGY8rvOMGVS3P08tKZMDcZU6LGA8w8duAox+NukTtb26F1zm04Go7n4ZqPrBNaDPdZehNTdkEV9T6PAYPBm06/F47PUwB8EqJNV+r2dBZpDvbKk+FW3jkRMWQtOPQVzqF2gSZB4FITPPSbYYAzGMZPLonAh813M0gQB50+X2nV5X9GWG0hYzPmQTc15GiQSs8CNhW/iZtnTtXbSuqaUpXFjoQzYW72uvmgH5JGgNXiEwDdFkrqhY0lbeCkM+Bu3nt+49Fuai/qq2jw6ACMxW2BlbvzvdNM6ACMxa+Bg7MbIuKaULWxguo7neZldl+8fdPmmfFVsddkuH8s2+WpPYUqDHR3uo30blM0l40QFO/k46Pw7V8hWP10VuS7bt3XVVmlV2LO6w4KWllGx6QlcsZ2ggxA7oSRLPhba0tHvmlOCGyXhICWkCLqIWCjT8S/Fb227gUB3mT7otX5bV1/y7GRkblCa0mBnDiGU6RQv/2muap3pss2T4rr7s30kbEiHxKkzNFJx2FlKMoEPDy7+GonRFwucK2Oh4EfkwQ4CP0IPPCv8CAai6onbmeNwzrG+hRRsRGqO45nndMAT9qTk2EGDR5vnD89CDIeByzQpkvpdsiIsw52I5boLlUQxQTFkHkigSMwSOPZN/4N9x3W52bajg/NJEpMqbAkJdLRe6bK1DbuhLcUVS8a74YY/52A+YxYJCR7zMQb5/GRKHQFFBpUilKMRvtWft7ppaWM6CJEdEAtkl/uB7B+a4jAntjVsn0tdZ/qqKlv9lUBqSgN50auAexCCQIJSeVKGXSYyEvAzhpxiyLqfXA39UChSqjKdUgIkaG85dDLEJiMhUYAUM73AH7ev7WH+uH1tC8KRU21rbZ216htT1jYEdp6MA+VBwNUNXBD50/hyh76usm1BQgeFzWbXywgdsnpR8kIfEJE0OY0VhcqTsd93PgrVgTjXldhI3oratsw/b/XvyVq/TWpddnUGGJMPo/CYs45w7Jv7wPs6b+cQHslTbfmdVaAOsKLN4p0U/dTAY9H5IKBj0Hix3RT6q6tpkDTVMAEPWc8IpfZ7nTSz9DIUowRCMS9WoQQGwMTMbtRJ2dxXtfPaGyuwc3JA6RALmin2YhRrhKw/UsKfBoW3SdO8e6ir7eqBRsIQPB3ehDGaka/yMm8edOZq/JH8Gf0LU0J1J6IwRtvBzqONtgWL5KMpR449YJeC4qcASlDINCtzra6RdzlJZidBD9LCiPUMAnMZv/yiy/blOm9PFwcNFqYUlQmMihcJX0BluZvOUKNFG2rS5qkJ4TDHJlSQUxM88HuKwXGK3bi01TmojlTZeSUw6IFtizrXsRw5HoFg7Ptcx8eBpXj5tdVlk1flPq6nZXamNFhaCEfAr/IyKfJ/9W9JmRW6vqxX23XnUqzpTGmwpiOn6bzZtpst4aR0UNyWCBomeg7QNe0HmchunigcT4/Tm1DL1q2uKYtqUoetTUIxmTOhZ2yd87Vje/W+SMUMbWvdqX2Zr8q8XDnM4wkFtpaKw9Ei39S6aejT6ImoJYHAN9fR82pbZktdf8lTTc4vPpElD5FkyoNErAeJz26wAm4eJ15UaWddyzht15wSJEah6KdJyONjyMeOwydx0YEYEFE4Wjc6szf7HqwXdI4EocNdx6NgDh1rFgAV+2w2lG2aL4qFmA/G7cBiH81bRzBhCcZ8M2/0LllBEYdQsO4FyKs1ZJEHefkPHQd0C6XP7tsep7rGpEUa+6xHRb788p9mmX1a5qs/JewXTtn5aR1k+8R+50ngBugEybOwPB/N4NTJ5vg4Wh1rDt3rjEXsQfLTi4XqfFAs0PI5yOWYA7Zigpww3Oc1B+ljVbe0oyXC3Ms7u2MwwYdRulIxD9IIg4WiCQvd6ntd6zKFaKR5LNNb3VTbOnXtio1qSz8lUA3PVIy0kQ+Bk3wPqbXmOnXOP2xUwtKYVHY6iwS5PNPNVuknbRsN9Y0trtr5iplrob81Mi6JHcdCMjY3aYUw4+C3dfX18WX5hbBjDhKWF5+YQHH3QJQ88bCcLbZE14avqrLsa9Jk+Cei5IwDj3c3pnEMqnV9pes2v8/TpCV4jpEgOc0meX+o7Z4xjI6QN7ppkhWBjCHkVJT1oDLsMSn8sOcUMBRtZFm3kl/nTatLhzTbhALbaRSg65nzqDjyGNuMscFQ6Pb/oYr6cfdhU043r+GH/Alcs6nKxtY9myJ29/5N0/+0fEg2UGHPuyQSIbNxN5K0HvpYPsF/oRtnBqasLYcQJeCcTeBogRAFiDMM4N5/dDXLvBFwfK4duw5w6AqOYn6/qMKIYcClTur0oUvONfbgppTNXI/QvbhZdYUzVBQghhxevqDjPFSZIPvuVJ4yBOl17/7uBON+gDYHiOt21aZdSYKwNRwSt5yZ8BDxIBNHBnbIeCsAa/RmYSweDdP3Asnzv948h99Q1uuUBlvjMDHN54W+T7ZFO48SUmLLiqPTJ2xHQylibtHnpCpySU/KYWRx2XHo9ly+R9XM4KoUTsHc6lVelXPZnlA0gy9yJrsCyDkmw7Qed7YCXZHdb+butcFJFfS78cPuyQVKwl2XeZvPqRhOKHDgJwd+yAPcnaOMd0QJnafajTUfh/bzSJ6LYWfBgSKKWNwrew4lvfHDjJ3R0IWjm23R5ptCQ9qn+KKzP5Niq290m2RJm1yX/9MpPRNhr9N2SxJy/JrknHzt9DlMAhF031WADzIItZsQMjpg/t2b4x8xDPa6rYdDPX3pfV7uP4AzejL31+XN65d1XdmWE/btSS/judgvOlQbAm3vkxoWNAF/kLA4J3H8+gqEb5Kj36QYQd0kpI9hQDmz76dCETaoWurPBOCl/kwBhtJmDxygZ1yXRZ7YHkO7tqTeRsGwj4fc3Md/rzKNip3HcXfNSf1lnHtdZ+ETKlE00IhwDnf3rsg2P74XoE3u7uMxMOI9iygMxic9YmGCUn8YHcT5YIqYTZKgp0TdCjaHUwQcP95/s21XVV6uxnnk4wYaSZGGCwop/bchJAoArsu0WpOZjKQsfJL0Ucpo15XuTNgdTym7w1Nhy21AshDVFuoq1U1Dre4MMvSktBB99h6+cIROKem23r2Iol87PSDtQC0Ova4cNBBET4tf6DbJC50512ImFNiOGg/xg8v1ujsvuteqDiqgG+27uVCay8lELmZBL/Ff5Cnh0Ait6SUxP4LveLEQvtjF4ZGLVFHv4CT++s3Bwofl08UTtY/pkk/YFxDhW2KTebVfoaqUp/PyakgJ/WDAGDwPYiIe6KLy4q1u68dlWyetXj06JlemddDJcukPNNFF2idJB4dD7bQOh8OWv6cZIM/VjPI31OzKlAYXisNSkehLWRAE/ohjOE3vjOPt0Cn0ZLr/dMP5D4Y0vQ6dQqd18G4HYiWnoOWAsK2fD1DGeIx8opx8AsqI0EL0qmK50TOKRoekLbsLH3fEr/LytulScgnhHqkhRZ4FyocDlvK53/3s5wL80qAFFxSopL7LWJuCm0Nyk2yokHsRe0TTNy3bepu221pTcUeC1ujIiZiTyG3q0SOcQKlhuPFriJ1St1XgUreE9dhTEcq0ytznmmWV6bum+/vdpq7WeaMbhzec3759+z/Ng+o0" \ No newline at end of file diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 1ee08907..f8c2a57c 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "eJzFnWtz3LaShv/KlnI+Jpv4Ep+T1NZW6WZbiWRNNLKzqVMpF0RCM1hxQIbESJqcOv99C7zMECAINLrh7CeXNW/30wRJENfGP/91pPizOvrx6L+EVLyWrPjvo6+PKqbWRz8ebcp8W/Dm28/Db5//c602xdHXRw9C5kc/vvz6KFuLIq+5PPrxn3tXx4VgjddLqzB9vf76KCtY0xz9eKSa/BvRfMOfO/mRm7JgdcNzIOaralD3tBc/vH71nYf579///fUedVZm2w2XygsbRIkvqwXcs2wG1smt2/L9G+CFnT9yqc43Qileey9uLCRe4NjVcbOT2Q1vym2d8UMArUNPALMuzNBevPyHpxwOpXB8V9aK3RU8VOpGEHurmMJ3F71xDdeVEqVsomIJOaOHeMPvec1lJuRq5qZFhjnnEBfqhzLnrfdbVq+4iorKsqWXVdyb9BXXf+F7U0wFtcxYwfzcTkJ8d08ur09//vz2+vLs/OxAU7vKyRqrrVL97oe/v/j+JahkOy+XF7fnN8eXUGgvx1MXl8cXH8K0Voan/PLx+vb889n1x5PL8zBsrKYylxcf3sGZnZp6D+3n5pHVQlegcc/OK9JjE2Y6Hx0g1HpqfDDHkwOEuB8aH2v+wYlC2s9MGOl6bqBFGW7ejaq0+PbdgXS7qziYozoxqpJWNWcbP6mVECtpWeb8x6b19G1VlxvRcH9rvKdqu8+d3efBbtrejwrlrZCiWfMc2KbxBWK5wn2l73snh0DutzJrHULjGFyYAbyBPWqVqHghJCfwBxcR/N+9JTD/QLgvNfp5/NwHL+53nz/DrnxPNmyRlzwt9PlLdpfuX3HJe3KKSz7bVgV/9naoemynxPWbFqxpbtd1uV2tIaiRHMe7rZls7st6A6HtxTjWr7WwuoTzqEGL7H3WNdvFVZBjE1xF2N32OKphg8PivgdJqv6FqIKd1eFBFRWyG7roX+K467OscOgbznL9EMahLSscuvMVBzZscNj9Gx5Hts1w8OGdj2NbVrSH7JQVxR3LHnydOPMBGywI3eLe0xlvlJBMXwUcPzJKGsGF4rUu1bf95xUVke0kaYSLrvVGCtDyQY+vdwgPpjegk5fW0GEIvHSNDKK58XfBtKPH4WjIhEKYac6Q6LG3wTLER7J3BK/CJiZ4Osvzdux+KVZdCx7QOjdtUH2/vG0+LZioYciDHoWL6+qSerUrrs74PdsW6r1YrX9litdXrH6AkWeMUYGI5ryuyxp60Xs5EjY0nqC0QY/ETbskfpy7W/JFRioQgxIHVEN5fGaMkf3m346vLq9Y5R0p6DVffvZ6DKLNX2tPS/5HkLbkf/w1lzWAaJd1vDLm5B0d9FaB7JbDnH/zAuneXCPhcj9dIwF2vrjwu15cIB1X4qTMd37nnWYCmLq5kPclxJXWBdxdV7y2eiNuf3sh1CEkSEMccLxgNfMPYA0iryPwwokU6yO2av1WFIrX4cIwpL4rOCnKO68rLcDFe1KU2cOlaPyv716Fg5wWgkt1w//Y8gDIUCJhZVHwLPh8H2RYjFRMyPEKBielVxEhV+23AYbqtHhgrUsm/PiaUt/jeyZqXdKP3F+JH2S42Kcrz1wQ58ozKOJc5lUppAoWzljoKxr3UpjQmi5U7O85y3ntvwW9BglQqoK84yMdBdRUpWz8r8RYiENdyKzcCLm64k3DVn6apcUBL9mfuyWvH0XGL3IulbgXgSfDaYGE63HPcitDD+NIhwPpZWQnLHD3BhEOcV1xqdtEW1HkgcsxpSTcOy5186YEAfdiXw1xvVWrEvgEWlrsTKXwRz8dZoG6ng4CONy7e/5wRLgCIlU+oIqHVunYKxRds6mOFYpw92u+YQH3WoJ0X2YP3H8DOgnF/XGe17zxf8wMJRJmLUOan9dGuf94c+n1/fHmEu14yVmdrdvOkb+YLC0OqAcq2gFCL2qvwkOMEacZxGTEKQZgjP3MACZjPzGAX1kthVwFIb0OB/q8fKUbP7qL2b7LvL25XBkNQPf0q8cUNwf7t65Tt6hLVWZlEeSb8iTMU+OLDOKeTr7LcHaZ8yyM0yokYT+IYtflMyxLj6Qu16zSs6y8FqwQf/JwkU4sKORlJHdJpLaTWO+ZzIswcawl0OxpNg/MNbv2ZVn28K1By3lV84wpnv9HevBL5GXmedtt1gNXuqkNXH8yY4aOwTHeOgueGXKNoOnGjjk8MQsbpEiWHtKHFulI+9fSvA+tjyezdVmfMRWsXA9KJGlx8Y4p/sR27VPXfYVOea078vqFCvID9kmi6kYW1C4ymMEsSQx9t02PO/Jn9ellZCy2+ReI6Veh1rrdVNaQr1SEK2qsi7p87ijmqEsoMNMuXRSTsUh4IM4hSkosV9tCiU+s2HJCVBMnXyK+X7a83i1VLeQK3pxHuEwX+4KpNS1U00O6yJKV5RcuwaViK/5p2DyGCdD0kC6yTy91HWXWWpj4XH6QUVZVMICqQvrW2whOtvf3vP4k+FOQY8oJzHatLaD7aogJvEvxEP5ADEIkR0+zO0bKZ2CGOgVxuqgVQp5Z0hoTwbBuGgQexAl44GfIZUTlR3FpvMi0EOmyPxwGy4LMvRJJempOa942q1kBbpW7jND8G74SpTx/Vlw2opSnpbwXqy2wi+s3R8e0zB+WYvXp9bEu3wtZbVXnFxDPnCk9FnwoKSLRLfa2oVcVXD/kxSPP2zbfFVcsZ4pdyP/lGbRPHecNHzF4sMQQU3janhVpSgjuDR/xvpV5faf9QcKyTPDsNKX0xUpHyPxCvi22utW7k4o9B6OZWODJQq5OS9momgmpwuUwsSCRXWtFvOC5pSJxZf3rmstrRIlP7fBRxPNTkW/LWLJpgSfr8otl2zY0enypJ7vnRXkHrWwOUjQrezCmnGdBrY5AsRd9eECuxR9xLN3ZluGEZIYYySvz3SWXK7U+ZUW2LSDdAZcNlr6Veb84DvikTixw5GHrHewjbappxCYO2VCZSxGeoxh0SAp8MoQ873G65tlDs90EQb2ORjkuVmUt1BqM2xvQuFF9NqcRmd+oepsBKgOHCZLdTYzBBioNcQJe958oavefBOxz+RgFPpePFGq/xTD4cTbVFGLbVR5W3MNH873GlHigK53AC51giyvilzxFrXiKCaIfzT+uV8C7MDJAljxkzVVoyRXwEsuVFKqEDr5ZcuzlDbuVbllwJMkQY3mbTTs2JztHwAb3jBk6hqqUXCpoi8bSY6n9V+6u0CvIcg79YszYoaOILflEZS4VyxS0wEdiAu+wae2yZNB8V/OWxEhi+WSqXqwELu+9mMADPcyUZ7d8ENA5GEOM5VU78LCxIcby6gZ8dXspklVzprjeCQW9c7YBjnvGszIPDyb2MiyjbfrhJpK8xth49uuU+5W811tVbYNFPmeHjUIxUfB8wXkd0fGdMUPGIMKVkdZgvff7fMOIXojlNFktNjolWAmcLHGYoNlV2UDm+g9KJGmy63mG49z4HEs5l+DjNs5l1FEbB9a5BNU9vYzAEHIFeyxMNZbYdTHDrE5H7qYMjk44qyGlOVbTLjFi0tthQmPDu/+p+vyDn/CC5IMSSaprWZ4/Z7yCfCFNNZpY1sAtMGMtgXZbPnDItfVKJOkRUGO2oi/tH7s/wZ04wgNy5o7A0BBn7tBP1rmQAlaeWkjgDHt+QKxBnIAH/A5NTVKwI25okj1Rqeikd6fbt33F6mbNCkj15jJKyG97EW/DNZ/HNmE0S3QsyySRtCNoMe2IedM0sSzq8lFAWqUzdoQoIo7pIp/KFc1Cv4PPbFMVHFjvjcUkHnAo2VRjid3fhv5QOzIBxc+a4mJ5y1W21rv6hwEKWKU7Y4aMQYAzwI+kWJYcj8eEeYY8CfO4XrX3DnCxbrskUcBGsJxGSH7Bn8VdwYdp+yaiEvfZYqMpmXrxpt2vEqYftHRaxAqHGTN0DE+uDIiz6Ke5RIgxRNjitYMSRwJvGSLuFnrH1XFRAOsqQ4znPTWn66184Pkw1mSnHpqnz5gmjyWiQPwe0JGBZ3nGWgINer3062rtb9loPTgca5jhYnjPmnUIqDXkQUntJKJqtOR0fLs5G9YIG2uRpQrbT07aMd4bx1wSqVX7vmz6LfgRH3anEZLfp6bCzRr6rWkRXYNGZU01jQjbcWiqUxBj7vycYYo44GP9aROaWd6AIwNuK3wEfWMd/yJ4HZDjAn49U/UutZ9JitR5pDNDagxrkmd0nuVMNxrHslOO+mCuzKMxNJ1zC/Y0d0ocCbp6krZscrCGvqO2Pg0VVlW6rZAR9Kmo27cL1gpxmGDZ9yWsOXJQ4kn1pq2uQBNuth5LFUqgRnrmLRNFAhvtmTHDxqDevA4T1ZvXSP/7j/X5s6oZpNPgMJmwx4Qq6zIF90toryvAnXTYIK+vaXecAb+WphpJBCYhoeUfgab+oGX9GKxvuNrW8oY32yL8+DtsaPTfBC/yOPjIBMf+me9glexeiONciozLBjhPY4ixPAncM3lQ4kmHngCcadvg6RFQIqtRsETBByV5qOWyXK3CDa5Ohbys1hZYcxpiLK982FaTzPNzvJGYwgNf30iM412xCvaU7IXkh+SK54Ld7ipg/WLJkZcJ6yWSeohDUhPY2ktTjSSWj/DcOYYYyetzAaXLnxPvkRZ5uoi/VKR6F0f8iIrbChtBvWl7CjmsZrD1OOp1ezJeUT7BagVLTmQCP8q2HkmFsSgEqc/TgfRpDkokSR9qtLgAXtJYjObVEWtqLDmRCXsd4McuwD6XQ9UIn5ycWmAvPFU1/6Wr96gwsIz+nK2I4TWHCY4dmf4tSeo3+6TiWVRjnw/+JQjYJYdRDOQWjSjGKyxDrS8U30AfgLEaTwR+F0dSJCtu32OS/Y6Lusx40wASpRyUaNJGNBySZHkkRbMqXqvdGdebGivAYNzUAk0GTbfQplm6FOKge9bqkJTlz0OqrA98VSpQB8tphOQ/3wPfvEGI4/yy5dtuoRZTfBWcl7PkSZhL8WfwrXCY4NjDMZMnO8W71WmHA41DQfhs00czPEmUqAYftOhgaxJN9V9PxLYPTC9RCcw9piliOfnt+uSmbTTGBXKwSxcFaNnDrGGKOPrUD/Gv64x5wpgwN8kwTRFLuzk2ttJwmKaIpV2JLTJMuRimaWLpCxnYRfRbp4hI/++slBw2d+izTRVN2xvHhjMypsXzay2U/tc8itofxtgGT7+WxQ6S/WSsxdN0zBGfuJEcy7zntc7lC2tRWnIsUx/3ELFkdGKA5zbw7eqWHMvcxEzDWHIssypYFgM19Vhq+znXmZqhz5JlQOIC9/WZ6hTEYaAyjjxYkSIAP8hj9V9PxLe+Wy+w1aeGmMwTcgVewzdjho2hKYut6tZet38L0i0DAtc99n7LVuDbDnCCjq9dxAx/20w9jQqt0MZqGhE4tmrJsUxV73RD6bZm4ZwqpppAbHsWkHOJTTWBGNXkMPUEKnT8zBAn4EXt/pi3TBBJOA+WJScwQcmiDkokaSuV2PD9Ppkgz9LjqMtX+6TsgCfYVGOJ589VeyY4cG/GxCARFzp9MGuIjwOzl2rODhsFdpPbvGWiSMC3JeVWt+WriIrcECN5OvOLzvUIawVZciSzTYoAyOy+F2I5ehkKrLEx1mJpZQVt2oy1SFr+0KeiEs8i/M4a6hTEruUbnipwWyEj4Nm2hmaGNsQJeNAXxGFDoAu1010wUfMNOG/6rCEtjq52iwthbIOl1zkfziIGlP5YjSbi9rvNGqLjeIQuexprKbTh3PQYqmmDpK9ZxUeJxcPVim1AXmzYelzGBbBMiBcrydS25p9en9a7SpWQFKBOI+QdOLiKJNOYMYNRaUahlhuh1nEdSIcJhQ3OaWzJ6Q9Zu4mz36Wj7xv0ozZjhyyEYSvpkOcGslzbaYTl6wPQQX3pkRTJqngG3YE61tJp0LUcLhsiPYaKp+lVZtk47fLgD/pQhxykigsdDzGObklUm+0OcENMOYWps1gBPqAjLYW2EBU0z+bEAM3dZvrbB9sVYcnplfg202tygXOCphp3wbdspc8xD6F6GZoBa3TuhUhOVkWnP3DZIOntxCFw6toQI3nlT0tgf3kkRbL0lEkDeyfGWvIL8VHmvC52Qq7apaDtJzsUgMsGd9kHT0shg+vPTHUK4vFdWSvo8jePaYpYTouy4bhYDNMUsSwVw5aLYZoilnYlEy4Ww5QcS+S7kei9aL2cMpnxAlEIDus0ES22BTqesW2aaLDP69QYGc/NZZB6c4n0XRftHrBga2UvRF/DkrM6W7dzQQ20MzJjhoyh4fXxikcdC+WywdGHZaGwVZam+q8nYhdPmV6iF8gHzBPG1NbeuHg6U1ws/7MpYI3pvRDH+dy2INqxwOKAUrvKpIxlFui7H/7+4vuXMJiV9G6KcWW5iwbMHtQzw/MfERSNt08kmaE6Tz6JgU32cU9B7n3bEZC/XfHNHa/tLsGUNNYRcGFQIsQNvw9Tbvg9HnR817S5/D7wJ3PocEKzlASk3N0Ye52mqE5BQCwu3jHFn9iufYj7mk4vnShrPYsy6apOQ4B5SBZiv/41OjDTLkU43bbeQBXokqeFj5e7gfCTBW8xAdQrXw2lf6Y4r9nuZHt/z2tzf7qDYyiTID8J/gRDaiUBuVVlVurTnZT3EkeyNLCFPlhYn2asxwR1EjMgfWJHCOepOa15u1iOFfOr7abh+Ozw4ZyI1RnPxIYVwQ+VLSVBL6TiK8Bn2JZSoJLVu6790K6X91ItLRUbeJkPIhIo9yPsvDCRzvUstz4K3BondpIMLRl7xlkEeKwmo9tFcWFmKyPAivIu/CrsRSlAvm/YSEVAlWXBmQS+cBMxGRwuz7GOgGs/iMMhSz6eIaQARaGENHMoe7kO/f8zfjLIEhPATnHgU2Uq8cjhNDxjtc0lX7Fs58F7rAKhwOaYDqfG6eRSvkAMIaEYyk1VNvytbMckvcCxkACsOVNcZ9MMj3xMtHjsGVPdOTke3F5DwHQdxbZHcsUqH8xUkpHNVZn7XpyxjADrj04N3ztLSUcGK39TSADuJNuIrK1fdE3nb8Q71Hj0ucyrUgzrqIe8YR6624AegGt7zCx8dkdMDNidXWXK9KRSicb535i9hohp18QIuboSeV7wJ1YHoVMLQgjhqoheB50/Z8XWX5idAo9425444nsXegUBoc/rLXbDun4fylTikf16KQDSUhKQbevphPnatXsNFfOBbbivChmpqKgbnpW1r7s8llFhjbl4fYbVONasR6NCLeIkreFRZnMf6qBKgtLz0aFGmUtOg1+yO16cCHXFGt+XxpbSoAu2K0qWw7CmmAb+ZcvrXbfgAAafGtACmMt64oR706xEg7u8DvoTDrt0h0WaEKAXb6jx6IvjD8dD5iWeX4lNaGDcbUAIIOebqlRcZl2GgHDxz1gkCEFFwBUd241sw6ruqZgAXnzideNvQ+w1BEx3VJoP0ikICL1po0s8rY8UnOaHmCLdFoQQ9iNbZsq+KdkQ4oE/c1/L9mdOaNX+zHe+uVT9M8G5LJ/GQ7y+Km6ixWMvheSL0gfrFRREt97Gy+gkBEh7fBag9W8KUwGP81x0x0aYKYQCeNOMFMwlf+TFha86OYgoILmC1ciWkoLUB4eB7uxYSAE+8Tozts84WL0Gj7liVWDis1eQELelkQZt5iQUF9pnSQgJtsAsYn0Z9CC39rS08CI6U0i50JGf0MsyFVPAXY45PRTgRR5kdNitdxBkpCKgzm/fX58tfZhOQUBAxhVTDCWGFwmSFwd+4M8KUGmOZQSYf/z3A2noV1sHel2DhAKRyzWred5NRHtZhjJJ7fRhu9GpxIPVoqHDX+z1xjvkpn8mOJeghTBjGQUGXP5iCglAfS5cJd6257T7eGOdE2c6tTeYuhw695XGxD454svHm4jx4P201mWZha5zok2AtXfRzUOd++cm9+sgVztvLW4KSVfS8DxQyx5ERFC4eTiWkWB6vaafoxVkBOiKRkICUHgnXfXPBOf9rLR/jGOkwqMOY9f68fXPcU20eOwNkyvfM97+TnBvHAnh2n82Jc6YpArCPnkkEIDztBESPDgyN2dCC6KUhe8hHiQUyJ1/0W8noAKWO5kFIVpEAQXmY6kzsf2RC/6nsJNQIN0Gm2HdHyuybRFqDcwbkQMZjp/eKv+0qUtOg4ua++9mJ6FAuoEbL6ST0CFR40pfYkgp5shff0CQU37jAusmQfun9xMrRB5+4ueMKIEMKesD/WhTSAJuaxmG9SIK6FE8BiquVoFHmJnLA9c0FRPAodGAhMOj42TKoUu0pNQLDL+jho6K8+8Ehm4EjinVLnVSENrJqJfXebFzCXiRznwCMeD8oa0yfLhekqZU24TN4Tl6Q0e4PCMzcujlmIgpYNl0+yqDyy5sKQU6JMgFDB5PxSTwo8h4t3nzXnjr9ImWgNVZgQNTJXtNAkxTMe9IlCmkAMtawSafbCkBKvSO4PB3ayQjwOaTAk6JgWSA0VjdPd3p/J/egrWkFKgeljwzTppy4AYRAdSlNNV1dfg22loqVq8CAVIPUir0ilVA5l5JRe6H8oFgS0/FA6kpYRd5sIUwVadC62cFTNbiVGD/XpGJNhUWMps0Y5EqhK6GB/M7eTJ4m74XDm/lqeAfZUzBt2oyGvjVnYjJ4Lm0ynNsb17laHxbeED0SEvB6gFwnYEWkpHAoSahBXTl3URLxYr7XTidki2lQiHlu5cRYDuZAYZLxzI87JatvCs0299J7n2NYP0zwbnY8EaxTaX3duv/BG/QjEWKELod2BERjA0SBHBeldl6ybNS5pP82fNRTK0ShALopk+0CbCwqsglTwFXqn2o4EVvWiQIIZwnxpYSoOVPy/Ao6UhFQRlnrDgg04NVotx3tTbkagwlAanHOE+E+mQdqjElGkIC0D9CSBsT1NZ5m2ougOhEeNBHGZg97wRUQGD2/CCigET4S3EQEUA3Fz7CzQXB9ZBu2gcYNAkwCyZ8r4qhI+C2Iod9RywlHulMf/zYn4dnIGczIL+CkazEn06GI9tnjHc78/A8w5V8GEh6W5RMvXhj1TlO1FiKYk12Zzgxzq0ZQII9MeYEuCbEgP6HtVLtGSWzi8ycVJ8pKRY7z7uX7kosj+Kd/HZ9Yq9tA5APZsliaJfvIIJo7RJE4cl2D4glkOyeEhHi9hiWyEjCy8BmAoEtBQPHEV6cMxMHbIEOMA7FVs3JzpyBdHIPQhTHOC3ECZgcFgL0PHeehBPiO8ACxYt9u6KOkqBEZJ8kAY/GdZAEMJK21WJuLduU+daias9fsZG0Y7x+8cPrV9+9hoH0R37SjZtlaXW5V8fjhloITKx7g3jo7yPssGX6wONyu2m+Hf5u3qN/jMunEsfVaPqnxfHm2+7vpt2Ll5alNVk2snVMjE2sL9nmLmdz9P2vAS+T7+bIh/Pb6PDQVZQzLrof/T4q+zSeg4fKdeiOaX/CGpHpkwam9vufQPZvRWG8yhMvncDny1U/DW7mah/TQ3vrdZ6TWh8u7Ho+bIXP22W5muSBG/wcfvN5OOyD7fLduDxNNT6P/Z65uXtu/Ozzs6iFzEQ17uINPvY/+ez7x3uSsXJwYv7u89Sdtz710P09bNlli5grkKnG5/HC9SS3tWZ3yNDF3IP88vs3tpvu6I55N93vXjdnoh2KZuPHZuzm8LvXTXf1bhfdbz7zn5pSLpjKRjVEN/aw/8E51GC9R869oPsfQh5YJQ629/0IffMtq4Rp+ea1aeSqUQzzuWrFdnSxkuV4x7vhpPsR4iAYjy3zO3WsYjC8zaxZsN1MPmOGE+eHbOrC/o5ZPlxfMtvJsDB0xsnws8fJXZk7rfXfPWZZKZutkTryYDr85jfvb9ep35GlArmc/6S5XPs/bzOID6XZAHA57jQgd4u6zLdZqBAGFcjlTVnw5rgoyqfxDLTL7VjpcX12fnl+e+5y1f3iMeWAG2JrPO7end+6PLw7v/UYra1RiYPd2jHqYJjK2ZstQ7d4cXx7+t5l2f7gMdQGVsb3g/H+Rx/5euksJf13H3fayBlx3c0cy8H8o1yFH+DFR3fUH31B/7HfKeyyPfzqcVGzp5OZmrD/yWc8/zWog5+C2vMdqMMfgTrwntewt1uJjdu+/WFi+Pv/AbzXX+A=" \ No newline at end of file +window.navigationData = "eJzFnW1v5DaSx7/Kwbsvs5fMQ2Y3weEAP03iTXvccXsmFyyCAS3R3TyrKYVS2+5d7Hc/UA/dIkWRxSpO7tVg3P+qX4mSKD4W//Gvk4a/NCffn/yXkA1XkhX/ffLVScWazcn3J9sy3xW8/vrz8Nvn/9w02+Lkq5NHIfOT719/dZJtRJErLk++/8fB1WkhWO310ipMX2+/OskKVtcn3580df4XUf+Fv3TyEzdlyVTNcyDmT9Wg7mmvvnv75hsP89+//furA+qizHZbLhsvbBAlvqwW8MCyGVgnt27Lt++AF3b5xGVzuRVNw5X34sZC4gWOXZ3We5nd8rrcqYwfA2gdegKYdWGG9ur13zzlcCyF0/tSNey+4KFSN4I4WMUUvrvojWu4qRpRyjoqlpAzeoi3/IErLjMh1zM3LTLMOYe4UD+UOW+93zG15k1UVJYtvazi3qQ/cf0XfjDFVFCrjBXMz+0kxHf3bHFz/tPn9zeLi8uLI63ZV07WWG2V6jff/fXVt69BJdt5WVzdXd6eLqDQXo6nLhenVx/CtFaGp/z88ebu8vPFzcezxWUYNlZTmaurDz/AmZ2aeg/t5+aJKaEr0Lhn5w3psQkznY8OEGo9NT6Y48kBQtwPjY81/+BEIe1nJox0PTfQogw370ZVWnz77ki621cczGk6MaqSbhRnWz+plRAraVnm/Pu69fR1pcqtqLm/Nd5Ttd3nzu7zYDdt70eF8l5IUW94DmzT+AKxXOG+0g+9k2MgDzuZtQ6hcQwuzADewR61SlS8EJIT+IOLCP5v3hKYfyDclxr9PH7ugxcP+8+fYVd+IBu2yEueFvr8JbtL94+45AM5xSVf7KqCv3g7VD22U+L6TUtW13cbVe7WGwhqJMfx7hST9UOpthDaQYxj/aKE1SWcRw1aZO9TKbaPqyDHJriKsLvtcVTDBofFfQ+SVP1LUQU7q8ODKipkN3TZv8Rx12dZ4dC3nOX6IYxDW1Y4dOcrDmzY4LCHNzyObJvh4MM7H8e2rGgP2TkrinuWPfo6ceYDNlgQusW9pwteN0IyfRVw/MgoaQRXDVe6VN/3n1dURLaTpBEuu9YbKUDLBz2+3iE8mN6ATl5ZQ4ch8Mo1Mojmxt8F044eh6MhEwphpjlDosfeBssQH8nBEbwKm5jg6SzP27H7lVh3LXhA69y0QfX98rb5tGRCwZBHPQoX19Ul9WrXvLngD2xXND+K9eYX1nB1zdQjjDxjjApE1JdKlQp60Qc5EjY0nqC0QY/ETbskfpy7W/JFRioQgxJHVE15fGaMkf3mX0+vF9es8o4U9JovP3s9BtHmr7WnFf89SFvx3/+YyxpAtMs6XRtz8o4OeqtAdsthzv/yCuneXCPhcj9dIwF2vrzyu15eIR1X4qzM937nnWYCmLq5kg8lxJXWBdzdVFxZvRG3v4MQ6hASpCEOOF4yxfwDWIPI6wi8cCLF+ohds3kvioarcGEYUt8VnBXlvdeVFuDiPSvK7HEhav/re1DhIOeF4LK55b/veABkKJGwsih4Fny+jzIsRjZMyPEKBielVxEh1+23AYbqtHig0iUTfnxNqe/xvRBKl/QT91fiRxku9unKMxfEufIMiriUeVUK2QQLZyz0FY17KUxoTRcq9h85y7ny34JegwQ0TQV5x0c6CqiuSln7X4mxEIe6klm5FXJ9zeuarf00S4sDLtg/9yuunkTGr3IuG/EgAk+G0wIJ1+Oe5U6GHsaRDgfSy8jOWODuDSIc4qbiUreJdqLIA5djSkm4H7jUzZsSBDyIfTXEza5Zl8An0NJiZyqFP/rpMAvU9XQQwOHe3fOHI8IVEKnyAVU8tErHXqHomk11rFCEu9/wLQu41xKk+zJ75P4b0Eko7k/zXPHa/zEzlEiYtQxpfl4b5f7j7cLr++PtAu14xZnKNm3nyF9MlhYH1AMV7QChF3VQ4SHGiNMMYjLiFAMwxn5mAJOxnxjAL0xJIddBSK/DgT6v3ujGj+5itu8yb28ub4wGoHv61WOKm4P9c9epW6qyKbOyCPJNeRLmufFFBnHPJ99lOLvMeRbGaRWScBhEsevyGZalR1JXG1bpWVauBCvEP3m4SCcWFPIqkrsiUttJrB+ZzIswcawl0OxpNg/MNbv2ZVn28K1By3mleMYanv9HevBr5GXmedtt1gNXuqkNXH8yY4aOwTHeOgueGXKNoOnGjjk8MQsbpEiWHtKHFulI+8fSvA+tj7c4ax+CIKvX0SiTsRk/zDlME8u83hWN+MSKHY+kTwxTxfHzjqv9qlFCruHNFaAbWoykyL5APH0PVg/B6h+AgZhWyAhktinVBWuCjY6jEklaXv3AGv7M9m3wXevsnCs9wKU/NEF+wD5JVN2IW7OPDGYwSxKDeVs/vY6MxTb/AjH9IpqN7k+UCtJ6i3BFjXWpypeOYo5GhgIz7dJFAa2J503TxRL/fYA4+RLx4WrneJfpYl+yZkML1fSQLrJkZfmFS3DVsDX/NGyqxARoekgX2afXuo6K/EID/SCjrKpgAFWF9K2315ztHh64+iT4c5BjygnMdg06YFjHEBN4C/EY/kAMQiRHLz9xzCDNwAx1CuJ0sTeEPLPUOyaCYT8BCDyIE/DAz5DLiMqP4tJ4kelS0mVFOQ4iB5kHJZL0XJ8r3jarWQFulbuM0PxbvhalvHxpuKxFKc9L+SDWO+DQj98cHdMqf1yJ9ae3p7p8r2S1azq/gHjmTOmx4ENJEYlusbcNvarg+iEvnnjetvmuecNy1rAr+b88g441xXnDRwweRDTEFJ62Z0WaEoJ7w0d8aGXe3Gt/kLAsEzw7TSl9sdIRMr+S74udbvXuZcNegtFMLPBkIdfnpawbxYRswuUwsSCRXWuovOC5JVRxZf3LhssbRIlP7fBRxPNTke/KWLJpgSfr8otl2zY0enypJ7vnRXkPrWyOUjQrezSWYsyCWh2BYi+G8oBci6LiWLqzLcOJ+gwxklfm+wWX62ZzzopsV0C6Ay4bLH0n837RKPBJnVjgyMOWVNhH2lTTiHUcsqYyVyI8RzHokBT4ZAh53uN8w7PHercNgnodjXJarEslmg0YdzCgcaP6bE4jMr9u1C4DVAYOEyS7mxiDDVQa4gS87j9R1O4/CdiX8ikKfCmfKNR+623w42yqKcS2qzzsRIGP5nuNKfFAVwCCFwDCFh3FLwWMWgkYE0Q/mn+q1sC7MDJAljxkLWJoKSLwEsu1FE0JHXyz5NjLG3bx3bHgSJIhxvK223ZsTnaOgA3uGTN0DFUpuWygLRpLj6X2X7n7Qq+szDn0izFjh44ituQTlblsWNZAC3wkJvCOmzkXJYPmgZu3JEYSyydT9SI+cHkfxAQe6GGmPLvlo4DOwRhiLK/ag4eNDTGWp2rw1R2kSJbirOF6hyD0ztkGOO4Fz8o8PJjYy7CMtumHm0jyGmPjOazf71e43+yaahcs8jk7bBQNEwXPl5yriI7vjBkyBhGujLQG673f/x5G9EIsp86U2OpUeSVwssRhgmZXZQ2Z6z8qkaRJNoAZjjMhQCzlUoKPobmUUUfQHFmXElT39DICQ8g17LEw1Vhi18UMszoduZsyODrjTEFKc6ymXWLEpLfDhMaGd/9T9fkHP+EFyUclkqSULC9fMl5BvpCmGk0sFXBr2FhLoN2Vjxxybb0SSYJseSHsd4H7x+7bcSdU8YCcOVUwNMRZVPQTp66kgJWnFhI4w144EGsQJ+ABv0NTkxTsiBuaZK9gKjrp3enyGVwzVW9YAaneXEYJ+W0v4n245vPYJoxmhY5llSSSdgQtph0xb5omlqUqnwSkVTpjR4gi4vg68ml10Sz0O/jCtlXBgfXeWEziAYeSTTWW2P1t6A+1IxNQ/KwpLpb3vMk2OtvFMEABq3RnzJAxCPDJCCMpliXH4zFhniFPwjxV6/beAS7WbZckCtgIltMIyS/4i7gv+DBtX0dU4j5bbDQla169a/erhOlHLZ0WscJhxgwdw7MrM+gs+nkuQWgMEbZ47ajEkcBbhoi7hX7gzWlRAOsqQ4znPdfnm5185Pkw1mSn5Jqnz5gmjyWiQPwe0JGBZ3nGWgINer3062rt79hoPTgca5jhYviR1ZsQUGvIg5LaSUTVaMnp+HZzNqwRNtYiSxW2n5y0Y7w3jrkkUqv2x7Lut+BHfNidRkh+n7INN2vot6ZFdAMalTXVNCJsx6GpTkGMufNzhinigI/1p030Z3kDjgy4rfAR9I11/IvgdUCOC/j1TNW71H4mqYPnkc7MwTGsSf7deZYzDW8cy07F64O5MvLG0HQuOtjT3ClxJOjqSdqyycEa+o7a+jRUWFXptkJG0Kdob98uWCvEYYJlP5Sw5shRiSepbVtdgSbcbD2WKhqBGumZt0wUCWy0Z8YMG0Pz7m2Y2Lx7i/R/+FhfvjSKQToNDpMJe0yosi6Ddr+E9qYC3EmHDfL66nbHGfBraaqRRGASElr+EWjqD1rWj8H6ljc7JW95vSvCj7/Dhkb/VfAij4OPTHDsn/geVskehDjOQmRc1sB5GkOM5UngnsmjEk869gTgTNsGT4+AEll1A0ugfVSSh1oW5XodbnB1KuRltbbAmtMQY3nl466anMgwxxuJKTzw9Y3EON41q2BPyUFIfkiueS7Y3b4C1i+WHHmZsF4iqYc4JDWBrb001Uhi+QTPnWOIkbw+F1C6/DnxHmmRp4v4S0Wqd3HEj6i4rbARqG3bU8hhNYOtx1Fv2hMji/IZVitYciIT+FG29UgqjEUhSH3OFKRPc1QiSfqwr+UV8JLGYjRPRaypseREJux1gB9HAvtcDlUjfHJyaoG98FTV/Jeu3qPCwDL68+cihtccJjh2ZPq3JKnf7BO8Z1E1R+75iSFglxxGMZBbNKIYb7CMZnPV8C30ARir8UTgd3EkRbLi9j0m2e+4VGXG6xqQKOWoRJO2ouaQJMsjKZpVcdXsL7je1FgBBuOmFmgyaLqFNs3SpRAH3bNWh6SsfhpSZX3g67IBdbCcRkj+ywPwzRuEOM7PO77rFmqxhq+D83KWPAlzJf4ZfCscJjj2cPzq2b7h3eq040HfoSB8tumjGZ4kSlSDD1p0sDWJpvqPJ2LbB6aXqATmHtMUsZz9enN22zYa4wI52qWLArTsYdYwRRx96of413XGPGFMmJtkmKaIpd0cG1tpOExTxNKuxBYZplwM0zSx9IUM7CL6rVNEpP93UUoOmzv02aaKpu2NY8MZGdPi+UWJRv9rHtHuD2Nsg6ffyGIPyX4y1uJpOuaIT9xIjmU+cKVz+cJalJYcy9THPUQsGZ0Y4Lk1fLu6JccytzHTMJYcy6wKlsVATT2W2n7OdaZm6LNkGZC4wH19pjoFcRiojCMPVqQIwA/yWP3HE/Gt79YLbPWpISbzhFyD1/DNmGFjqMti13Rrr9u/BemWAYHrHnu/Y2vwbQc4QcfXLmKGv22mnkaFVmhjNY0IHFu15Fhmo/a6oXSnWDiniqkmENueBeS8blNNIEY1OUw9gQodPzPECXhRuz/mLRNEEs6DZckJTFCyqKMSSdrJRmz5YZ9MkGfpcdTVm0NSdsATbKqxxMuXSi9Xg+7NmBgk4kKnD2YN8XFg9lLN2WGjwG5ym7dMFAn4tqTc6rZ6E1GRG2IkT2d+0bkeYa0gS45ktkkRAJndD0IsRy9DgTU2xlosraygTZuxFknLH/tUVOJFhN9ZQ52C2LV8w1MFbitkBDzbKWhmaEOcgAd9QRw2BLpo9roLJhTfgvOmzxrS4uhqt7gQxjZYusr5cBYxoPTHajQRt99t1hAdxxN02dNYS6EN56bHUE0bJH3DKj5KLB6uVmwD8mLD1uMqLoBVQrxYS9bsFP/09lztq6aEpAB1GiHvwNFVJJnGjBmMSjMKtdqKZhPXgXSYUNjgnMaWnP6QtZs4+106+r5BP2ozdshCGLaSDnluIMu1nUZYvj4AHdSXHkmRrIpn0B2oYy2dBl3L4bIh0mOoeJpeZZaN0y4P/qAPdchBqrjQ8RDj6JZEtdnuADfElFOYOosV4AM60lJoS1FB82xODNDcXaa/fbBdEZacXonvMr0mFzgnaKpxF3zH1voc8xCql6EZsEbnQYjkZFV0+gOXDZLeThwCp64NMZJX/n0F7C+PpEiWnjKpYe/EWEt+IT7KnKtiL+S6XQrafrJDAbhscJd99LQSMrj+zFSnIJ7el6qBLn/zmKaI5bwoa46LxTBNEcuqYdhyMUxTxNKuZMLFYpiSY4l8NxK9F62XcyYzXiAKwWGdJqLlrkDHM7ZNEw32eZ0aI+O5XQSptwukb1W0e8CCrZWDEH0NK85UtmnngmpoZ2TGDBlDzdXpmkcdC+WywdGHZaGwVZam+o8nYhdPmV6iF8gHzBPG1NbeuHg6U1ws/7MtYI3pgxDH+dy2INqxwOKIavaVSRnLLNA33/311bevYTAr6d0U48pyFw2YPahnhuc/Iigab59IMkN1nnwSA5vs456C3Pu2IyB/vubbe67sLsGUNNYRcGFQIsQtfwhTbvkDHnR6X7e5/D7wZ3PocEKzlASk3N8ae52mqE5BQCyvfmANf2b79iHuazq9dKJUehZl0lWdhgDzkCzEfv1rdGCmXYpwum29gSrQJU8LHy93A+EnC95iAlBrXw2lf6Y4V2x/tnt44Mrcn+7gGMokyE+CP8OQWklA7poyK/XpTo33EkeyNLClPlhYn2asxwR1EjMgfWJHCOe5Ple8XSzHivnVdtNwfHb4cM7E+oJnYsuK4IfKlpKgV7Lha8Bn2JZSoJKpfdd+aNfLe6mWlooNvMxHEQmU+xF2XphI53qWWx8Fbo0TO0mGloy94CwCPFaT0e2iuDCzlRFgRXkffhUOohQg3zdspCKgyrLgTAJfuImYDA6X51hHwLUfxOGQJR/PEFKAomiENHMoe7kO/f8zfjLIEhPAvuHAp8pU4pHTIdAJa2agMwbSH7lnLOlZ8DXL9j7uvFUgFNhE1vFoOp3ByheIISQUQ7mtypq/l+3Apxc4FhKAirOG65Sd4eGViRaPvWBNdxiPB3fQEDBdb7Tt9lyzygczlWRkfV3mvrdzLCPA+vNZw/fOUtKRwS+MKSQA95JtRdZWYro69fcUHGo8+lLmVSmGxdpDcjIP3W1AD8C1B2cWPrvtJgbsTuEyZXrytUTj/G/MQUPEtAtvhFxfizwv+DNTQejUghBCuCqi10GXL1mx8xdmp8Aj3rfHmvjehV5BQOhDgYv9sHnAhzKVeORkCdcE5V62FY8AXJWlJCDbVuAZ87XPDxoq5gPbcl8tNVJRUbc8K5Wv2z+WUWG1uQh/hlU71t5Ho0It+ySt+lGGdh/qqEqC0vPqoXafS06DL9g9L85Ec81q38fMltKgS7YvSpbDsKaYBv55x9W+WzgBg08NaAHMZW9xwr3pYqLBXX4K3UqAXbrDIk0I0Is31Hj01emH0yGDFM+vxTY0wO82IASQ821VNlxmXaaDcPHPWCQIoYmAN3RsN0IPq7qnYgJ4+Ymr2t+GOGgImO7INx+kUxAQevNJl0BbH404zXMxRbotCCEcRujM1INTsiHEA3/ivsbzT5zQcP6J731zwvpngnNZPo+Hqn1V3ESLxy6E5MvSB+sVFES3bsjL6CQESHsMGKD1bwpTAU/zXHTHX5ipkAJ404wUzII/8eLKV50cRRSQXMNqZEtJQeoD0EB3diykAJ+5yoxtQA5Wr8FjrlkVmMDtFSTEXWmkc5s50cWF9lkSQoItlItYJwc9kK499S28GNAUUi505Cf0skzFFHCXK08PBXiRRxkdducdBBmpCKjLux9vLlY+TKcgICBDlylGK8OLHcmLHD/wlwZQaY5lBJh/iPkDaXRZWwd6XYOEApGrDVM87ybUvSxDmaR2+rDb6pTowWrR0OEv9mbrHXLTPxOcS9CCnrGMAgMu4zGFBKA+364S79vz5n28sc6JM53aG2VdDp37Y2NinxxV5uNNxHjwYeZsUWah65xoE2Dt3YDzUOc+wMn9OsqbvbcWN4WkK6l5HqhljyIiKNw8HMtIML3u1M/RCjICdEUjIQEovPO6+meC837i2z/GMVLhUcexa/34+ue4Jlo89pbJte8Zb38nuDeOtnDto5sSZ0xSBWGfoBIIwHlqCgkeHJmbM6EFUcrC9xAPEgrk3r94uRNQAau9zIIQLaKAAvOx1JnY/ugI/1PYSSiQbqPQsLSQFdmuCLUG5o3IgQzHaO8a/7SpS06DC8X9d7OTUCDdwI0X0knokKhxpS8xpBRzdLE/IMhpxXGBdZOg/dP7iRUiDz/xc0aUQIbU+4F+tCkkAXdKhmG9iAJ6Ek+BiqtV4BFmBvbANU3FBHBoNCDh8Og4KXToEi0p9QLD76iho+L8O5qhG5pjSrVLARWEdjLq5XVe7JwIXqQzL0IMOH9sqwwfrpekKdU28XR4jt7QES7PyPAcejkmYgpY1t3+0OCyC1tKgQ6JfgGDx1MxCfwkMt5tQn0Q3jp9oiVgdXbjwFTJQZMAU1fMOxJlCinAUjWwySdbSoAKvbM5/N0ayQiw+eSGU2IgqWE0VndP9zqPqbdgLSkFqoclL4wTsxy4QUQAdalZdV0dvo22lorVq0CA1KOUCr1mFZB5UFKRh6F8INjSU/FAakrYVR5sIUzVqdD6WQGTtTgV2L8dZaJNhYXMJs1YpAqhq+HB/E6eDN6mIYbDW3kq+EcZU/CtmowGfnUnYjJ4Lj30HNubHzoa3xYeED3SUrB6AFxn0oVkVnCoSWgBXXk30VKx4mEfTgtlS6lQSPkeZATYXmaA4dKxDA+7Y2vvCs32d5J7XyNY/0xwLra8bti20tvH9X+CN2jGIkUI3SbviAjGBgkCuKzKbLPiWSnzSR7w+SimVglCAXTTJ9oEWFhV5JKngDdN+1DBi960SBBCON+NLSVAy7+vwqOkIxUFZZwV44BMD4iJct/V2pCrMZQEpB7jPBPNJ+twkCnREBKA/hFC2pigts7blHkBRCfCgz7KwOx5J6ACArPnRxEFJMJfiqOIALq98hFurwiuh7TZPsCgSYBZMuF7VQwdAbcTOew7YinxSGca56f+XD8DOZvJ+Q2MZCUwdTIcWUtjvNsZlOcZriTKQNL7omTNq3dWneNEjaUo1mR3hhPj3JoBJNgTY06Aa0IM6H9YK9WetTK7yMxJ9ZmSYrHz1XvprgT5KN7Zrzdn9to2APloliyGdvkOIojWLkEUnqz9gFgCSfspESFuj2GJjCS8DGwmENhSMHAc4cU5M3HAFugA42jYuj7bmzOQTu5RiOIYp544AZNDT4Ce587FcEJ8B3GgeLFvV9SRGJSI7BMx4NG4DsQARtK2WsytZdsy31lU7flPbCTtGG9ffff2zTdvYSD9kZ9042ZZWl0e1PG4oRYCE1VvEA/9bYQdtkwfeVzutvXXw9/Ne/S3cflU4rQaTf+0OF5/3f3dtHv12rK0JstGto6JsYn1gm3vczZHP/wa8DL5bo58OL+NDg9dRTnjovvR76OyTxU6eqhchweZ9mesFpk+MWFqf/gJZP9eFMarPPHSCXy+XPXT4Gau9jE9tLde5zlR+pBk1/NhK3zeFuV6kmpu8HP8zefhuA+2y3fj8jTV+Dz2e+bm7rnxs8/PUgmZiWrcxRt8HH7y2feP9yQp5uDE/N3nqTs3fuqh+3vYsssWMVcgU43P45XrSW5rze6wpKu5B/n1t+9sN90RJPNuut+9bi5EOxTNxo/N2M3xd6+b7urdLrrffOZ/r0u5ZE02qiG6sYfDD86hhvF71FenYibnm/072N+k/rX8Oetgh79y7d6revgh5OED0wsL5yOyfw/5Y5U4unjoZyTqr1klTMt3b00jVw1qmM9Vo7ajq7Usxzv8DSfdjxAHwXhsmd+pY9WG4W1mjYbtZnKTDCfOWzR1YX+3LR+uL7ftZFgIO+Nk+Nnj5L7Mndb67x6zrJT1zkiVeTQdfvOb97fr3O/IUoFczn/CXa79n/MZxIfSbPC4HHcakLulKvNdFiqEQQVyeVsWvD4tivJ5POPucjtWelxfXC4u7y5drrpfPKYccENsjcfdD5d3Lg8/XN55jDbWKMzRbuMYZTFM5ezNlqFbvDy9O//RZdn+4DHUBlYS/aPx4Ucf+WblLCX9dx932qgbcd3NOsvB/KNchR/g5Ud31B99Qf9+2Bntsj3+6nGh2PPZTE3Y/+Qznv8aqOCnQHm+Ayr8EVCB91zB3u5GbN327Q8Tw9/+DxE9CX8=" \ 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 2fdba302..898adb04 100644 --- a/docs/classes/ApiApp.html +++ b/docs/classes/ApiApp.html @@ -6,7 +6,7 @@ compatible with either API Gateway or an ALB.

Extending this class will allow creating an app implementation for runtimes, AWS Lambda, Local Web Server etc.

-

Hierarchy (View Summary)

Index

Constructors

constructor +

Hierarchy (View Summary)

Index

Constructors

constructor

Properties

apiServer appConfig appContainer @@ -31,24 +31,24 @@ 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.

-

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>

  • Run using the passed event and context, ultimately should call the +

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

                          Returns RequestBuilder

                          Staticpost

                          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

                                                                                                                                    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

                                                                                                                                      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

                                                                                                                                            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

                                                                                                                                            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

                                                                                                                                              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

                                                                                                                                                    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

                                                                                                                                                      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

                                                                                                                                                        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

                                                                                                                                                        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

                                                                                                                                                            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 new file mode 100644 index 00000000..b992cb08 --- /dev/null +++ b/docs/interfaces/_internal_.ALBEvent.html @@ -0,0 +1,10 @@ +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 +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..f2cddb5b --- /dev/null +++ b/docs/interfaces/_internal_.ALBEventHeaders.html @@ -0,0 +1 @@ +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 new file mode 100644 index 00000000..309740dc --- /dev/null +++ b/docs/interfaces/_internal_.ALBEventMultiValueHeaders.html @@ -0,0 +1 @@ +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 new file mode 100644 index 00000000..08ae8ce3 --- /dev/null +++ b/docs/interfaces/_internal_.ALBEventMultiValueQueryStringParameters.html @@ -0,0 +1 @@ +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 new file mode 100644 index 00000000..b734ce6c --- /dev/null +++ b/docs/interfaces/_internal_.ALBEventQueryStringParameters.html @@ -0,0 +1 @@ +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 new file mode 100644 index 00000000..d2ba5acf --- /dev/null +++ b/docs/interfaces/_internal_.ALBEventRequestContext.html @@ -0,0 +1,2 @@ +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